home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / web / fweb / fweb-1.40 / READ_ME.FWEB < prev    next >
Text File  |  1993-10-29  |  6KB  |  159 lines
  1.                --- FWEB v. 1.40 ---
  2.                    October 25, 1993
  3.  
  4.  
  5. IMPORTANT NOTES:
  6.  
  7. * FWEB is gravitating toward the GNU standards for configuration,
  8. makefiles, etc.  If you are a Unix user (more precisely, if you have sh
  9. available), please follow the installation procedure described below under item
  10. (0) of ``SUMMARY of INSTALLATION PROCEDURE''.
  11.  
  12. * Documentation for this version is maintained in gnu texinfo format.  The
  13. installation procedure will install the relevant files.  Online information
  14. will then be available through emacs' info browser.  Assuming that the
  15. relevant texinfo macros are installed on your system, you can obtain
  16. printed documentation by saying
  17.  
  18.     cd manual
  19.     tex fweb.texinfo
  20.  
  21. * The old, v1.30 user manual is still provided, as it is more pedagogical
  22. in places.  The following instructions pertain to that OBSOLATE documentation:
  23. There is a separate make file for the user manual:  manual/Makefile.
  24. To obtain a short reference guide to FWEB, you must first run ./configure
  25. (see below).  Then say 
  26.  
  27.     cd manual
  28.     make guide
  29.  
  30. To obtain the complete (LONG!) user manual (which incorporates the
  31. reference guide as several appendices), say
  32.     
  33.     cd manual
  34.     make manual
  35.  
  36. The indexes for the user manual and reference guide require the utility
  37. routine makeindex.  This can be obtained by anonymous ftp from
  38.  
  39.     ftp.math.utah.edu:/pub/tex/pub/makeindex/2-11
  40.  
  41. (The extension .trz is equivalent to .tar.Z.)
  42.  
  43.  
  44. SUMMARY of INSTALLATION PROCEDURE:
  45.  
  46.   (0) If you are a Unix user, especially one with an ANSI-C compiler
  47. (please use gcc), please try to install FWEB by doing the following: 
  48.  
  49. ------------------------------------------------------------------------------
  50.     cd fweb-1.40
  51.     ./configure 
  52.     cd web
  53.     make -n install (Previously, this command was put after `make
  54. bootstrap'.  It's now put here because previously the make file sometimes
  55. recompiled things unnecessarily.  The -n option is used to see where
  56. various files are going to be put.  If you need to make changes to system
  57. paths, etc., make them in defaults.mk.in, then rerun ./configure.)
  58.     make bootstrap
  59.     [Log on as root]
  60.     make install
  61. -------------------------------------------------------------------------------
  62.  
  63. ./configure is a sh script that was generated automatically by running the
  64. utility program autoconf.  It first reads an FWEB configuration file whose
  65. default name is configure.ini.  (More about that below.)  Then it
  66. attempts to figure out various local system features automatically.
  67. Finally, it generates two files from autoconf templates:
  68.  
  69.     ./web/defaults.mk.in  => ./web/defaults.mk
  70.     ./web/custom.h.in => ./web/custom.h
  71.  
  72. The file defaults.mk is included into both ./web/Makefile and
  73. ./manual/Makefile.  The file custom.h is included into the C code by the
  74. ./web/*.c files.  Check out what configure produces, especially for the
  75. directory prefixes in the INSTALLATION section of defaults.mk.  If you need
  76. to make changes, make them in the *.in files, then run ./configure again.
  77.  
  78.   For more information about automatic configuration, read the file
  79. UNIX_INSTALL.  
  80.  
  81.   The present procedure differs in one respect from standard ./configure
  82. protocol: an extra layer of variable definitions is used for variables
  83. related to FWEB that are not figured out automatically by ./configure.
  84. E.g., instead of saying in defaults.mk.in ``OBJ = obj'', we say ``OBJ =
  85. @_OBJ_@''.  Configure replaces the @_OBJ_@ with the present value of the
  86. environment variable _OBJ_.  To give that a value, configure sources in the
  87. contents of the file $CONFIGURE_INI.  If the environment variable CONFIGURE_INI
  88. isn't defined, then the default file config.ini is read.  This mechanism is
  89. partly used to aid the developer--files like ansi.ini are used to
  90. automatically generate the old-style bootstrap files---and partly to ease
  91. the transition to ./configure, which doesn't figure everything out for
  92. itself yet.
  93.  
  94.   Note that the old bootstrapping mechanism remains in place for those who
  95. need it.  That consists of the boot subdirectory, containing various
  96. suggested defaults.mk and custom.h files.  Therefore, if configure doesn't
  97. seem to be doing the right thing, please let me know and revert to the old
  98. procedure using the installation script install.fweb.
  99.  
  100.   (1) If you are a Unix user, but ./configure didn't work, use the
  101. installation script install.fweb.
  102.  
  103. Otherwise:
  104.  
  105.   (2) Select a boot subdirectory, for example
  106.  
  107.     boot/unix/ansi/
  108.  
  109. that you think corresponds to your machine.   That directory should contain
  110. a READ_ME file (that you should read!), and in particular the files
  111.  
  112.     custom.h defaults.mk
  113.  
  114. (Even if there's a bootstrap subdirectory that sounds like your machine,
  115. please try to use the ansi bootstrap first.  Some of the bootstraps may be
  116. out of date.  If your compiler is supposed to be ANSI but it doesn't work
  117. with the ansi bootstrap, please (a) notify me; (b) complain to the vendor.)
  118.  
  119.   (3) COPY custom.h to the web subdirectory.  This file contains macro
  120. definitions and file includes that may need to be modified for your
  121. particular compiler and/or operating system.  If the compile and link below
  122. does not work, you may have to edit custom.h, following the instructions in
  123. that file.
  124.  
  125.   (4) COPY defaults.mk to the web directory.  Then examine it
  126. to see if anything needs to be changed there.  This file is included into
  127. web/Makefile; it sets up the compiler and link lines, etc.  For example, you
  128. may want to include a compiler optimization command.  As another example,
  129. Cray users may need to change the name of the compiler from cc to scc.  If your
  130. compiler permits, also use the flag that makes the default |char| type
  131. |unsigned|.
  132.  
  133.   (5) Say
  134.  
  135.     cd web
  136.     make -n bootstrap
  137.  
  138. to see what will happen when you compile and link.  If all seems in order,
  139. then do it without the -n option.
  140.  
  141.   (6) If something doesn't compile properly, you may need to edit custom.h;
  142. follow the instructions in that file.
  143.  
  144.   (7) (Omitted.)
  145.  
  146.   (8) With this old-style bootstrapping procedure, there is no automatic
  147. procedure for installing the files into their final resting place.  Look
  148. into the Makefile for the ``install:'' target to see what should be done.
  149.  
  150.   (9) To obtain brief help about the Makefiles, type
  151.  
  152.     make help
  153.  
  154. To learn more, read the notes at the beginning of Makefile.
  155.  
  156.  
  157.  
  158.  
  159.